Download @react-docgen_cli@3.0.5 source code.zip (react-docgen)

react-docgen Overview

A CLI and toolbox to extract information from React component files

react-docgen is a CLI and toolbox to help extracting information from React components, and generate documentation from it. It uses @babel/parser to parse the source into an AST and provides methods to process this AST to extract the desired information. The output / return value is a JSON blob / JavaScript object. It provides a default implementation for React components defined via React.createClass, ES2015 class definitions or functions (stateless components). These component definitions must follow certain guidelines in order to be analyzable. Installing the module adds a react-docgen executable which allows you to convert a single file, multiple files or an input stream. We are trying to make the executable as versatile as possible so that it can be integrated into many workflows. By default, react-docgen will look for the exported component created through React.createClass, a class definition or a function (stateless component) in each file.

Additional Details for react-docgen

Programming Language

TypeScript

Registered

2022-09-07

Last Updated

2026-03-13

Maintainers

sf-editor1

Keep Me Updated!

Get an email when this software releases a new version (no other emails will be sent). Get newsletters and notices that include site news, special offers and exclusive discounts about IT products & services.

I understand by clicking on "Subscribe" below I am agreeing to the SourceForge Terms of Use and the Privacy Policy which describe how we use and share your data. I agree to receive these communications from SourceForge.net. I understand that I can withdraw my consent at anytime.

JavaScript is required for this form.

react-docgen